home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / SIMPLEITEM.PY < prev    next >
Encoding:
Python Source  |  2000-06-12  |  14.9 KB  |  417 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. '''This module implements a simple item mix-in for objects that have a
  86. very simple (e.g. one-screen) management interface, like documents,
  87. Aqueduct database adapters, etc.
  88.  
  89. This module can also be used as a simple template for implementing new
  90. item types. 
  91.  
  92. $Id: SimpleItem.py,v 1.78 2000/06/12 19:49:48 shane Exp $'''
  93. __version__='$Revision: 1.78 $'[11:-2]
  94.  
  95. import regex, sys, Globals, App.Management, Acquisition, App.Undo
  96. import AccessControl.Role, AccessControl.Owned, App.Common
  97. from webdav.Resource import Resource
  98. from ExtensionClass import Base
  99. from DateTime import DateTime
  100. from CopySupport import CopySource
  101. from string import join, lower, find, split
  102. from types import InstanceType, StringType
  103. from ComputedAttribute import ComputedAttribute
  104. from AccessControl import getSecurityManager
  105. from Traversable import Traversable
  106.  
  107. import marshal
  108. import ZDOM
  109.  
  110. HTML=Globals.HTML
  111. StringType=type('')
  112.  
  113. class Item(Base, Resource, CopySource, App.Management.Tabs, Traversable,
  114.            ZDOM.Element,
  115.            AccessControl.Owned.Owned,
  116.            App.Undo.UndoSupport,
  117.            ):
  118.     """A common base class for simple, non-container objects."""
  119.     isPrincipiaFolderish=0
  120.     isTopLevelPrincipiaApplicationObject=0
  121.     
  122.     def manage_afterAdd(self, item, container): pass
  123.     def manage_beforeDelete(self, item, container): pass
  124.     def manage_afterClone(self, item): pass
  125.  
  126.     # The name of this object and the name used to traverse to thie
  127.     # object in a URL:
  128.     id=''
  129.  
  130.     # Alias id to __name__, which will make tracebacks a good bit nicer:
  131.     __name__=ComputedAttribute(lambda self: self.id)
  132.  
  133.     # Name, relative to SOFTWARE_URL of icon used to display item
  134.     # in folder listings.
  135.     icon=''
  136.  
  137.     # Meta type used for selecting all objects of a given type.
  138.     meta_type='simple item'
  139.  
  140.     # Default title.  
  141.     title=''
  142.  
  143.     # Default propertysheet info:
  144.     __propsets__=()
  145.  
  146.     manage_options=(
  147.         App.Undo.UndoSupport.manage_options
  148.         +AccessControl.Owned.Owned.manage_options
  149.         )
  150.     
  151.     # Attributes that must be acquired
  152.     REQUEST=Acquisition.Acquired
  153.  
  154.     # Allow (reluctantly) access to unprotected attributes
  155.     __allow_access_to_unprotected_subobjects__=1
  156.  
  157.  
  158.     def title_or_id(self):
  159.         """
  160.         Utility that returns the title if it is not blank and the id
  161.         otherwise.
  162.         """
  163.         title=self.title
  164.         if callable(title):
  165.             title=title()
  166.         if title: return title
  167.         id=self.id
  168.         if callable(id):
  169.             id=id()
  170.         return id
  171.  
  172.     def title_and_id(self):
  173.         """
  174.         Utility that returns the title if it is not blank and the id
  175.         otherwise.  If the title is not blank, then the id is included
  176.         in parens.
  177.         """
  178.         title=self.title
  179.         if callable(title):
  180.             title=title()
  181.         id=self.id
  182.         if callable(id):
  183.             id=id()
  184.         return title and ("%s (%s)" % (title,id)) or id
  185.     
  186.     def this(self):
  187.         # Handy way to talk to ourselves in document templates.
  188.         return self
  189.  
  190.     def tpURL(self):
  191.         # My URL as used by tree tag
  192.         url=self.id
  193.         if hasattr(url,'im_func'): url=url()
  194.         return url
  195.  
  196.     def tpValues(self):
  197.         # My sub-objects as used by the tree tag
  198.         return ()
  199.  
  200.     _manage_editedDialog=Globals.HTMLFile('editedDialog', globals())
  201.     def manage_editedDialog(self, REQUEST, **args):
  202.         return apply(self._manage_editedDialog,(self, REQUEST), args)
  203.  
  204.     def raise_standardErrorMessage(
  205.         self, client=None, REQUEST={},
  206.         error_type=None, error_value=None, tb=None,
  207.         error_tb=None, error_message='',
  208.         tagSearch=regex.compile('[a-zA-Z]>').search):
  209.  
  210.         try:
  211.             if error_type  is None: error_type =sys.exc_info()[0]
  212.             if error_value is None: error_value=sys.exc_info()[1]
  213.             
  214.             # turn error_type into a string            
  215.             if hasattr(error_type, '__name__'):
  216.                 error_type=error_type.__name__
  217.  
  218.             # allow for a few different traceback options
  219.             if tb is None and error_tb is None:
  220.                 tb=sys.exc_info()[2]
  221.             if type(tb) is not type('') and (error_tb is None):
  222.                 error_tb=pretty_tb(error_type, error_value, tb)
  223.             elif type(tb) is type('') and not error_tb:
  224.                 error_tb=tb
  225.  
  226.             if hasattr(self, '_v_eek'):
  227.                 raise error_type, error_value, tb
  228.             self._v_eek=1
  229.    
  230.             if lower(str(error_type)) in ('redirect',):
  231.                 raise error_type, error_value, tb
  232.  
  233.             if not error_message:
  234.                 if type(error_value) is InstanceType:
  235.                     s=str(error_value)
  236.                     if tagSearch(s) >= 0:
  237.                         error_message=error_value
  238.                 elif (type(error_value) is StringType
  239.                       and tagSearch(error_value) >= 0):
  240.                     error_message=error_value
  241.  
  242.             if client is None: client=self
  243.             if not REQUEST: REQUEST=self.aq_acquire('REQUEST')
  244.  
  245.             try:
  246.                 if hasattr(client, 'standard_error_message'):
  247.                     s=getattr(client, 'standard_error_message')
  248.                 else:
  249.                     client = client.aq_parent
  250.                     s=getattr(client, 'standard_error_message')
  251.                 v=HTML.__call__(s, client, REQUEST, error_type=error_type,
  252.                                 error_value=error_value,
  253.                                 error_tb=error_tb,error_traceback=error_tb,
  254.                                 error_message=error_message)
  255.             except: v = error_value or "Sorry, an error occurred"
  256.             raise error_type, v, tb
  257.         finally:
  258.             if hasattr(self, '_v_eek'): del self._v_eek
  259.             tb=None
  260.  
  261.     def manage(self, URL1):
  262.         " "
  263.         raise 'Redirect', "%s/manage_main" % URL1 
  264.  
  265.     # This keeps simple items from acquiring their parents
  266.     # objectValues, etc., when used in simple tree tags.
  267.     def objectValues(self, spec=None):
  268.         return ()
  269.     objectIds=objectItems=objectValues
  270.  
  271.     # FTP support methods
  272.     
  273.     def manage_FTPstat(self,REQUEST):
  274.         "psuedo stat, used by FTP for directory listings"
  275.         from AccessControl.User import nobody
  276.         mode=0100000
  277.         
  278.         # check read permissions
  279.         if (hasattr(self.aq_base,'manage_FTPget') and 
  280.             hasattr(self.manage_FTPget, '__roles__')):
  281.             try:
  282.                 if getSecurityManager().validateValue(self.manage_FTPget):
  283.                     mode=mode | 0440
  284.             except: pass
  285.             if nobody.allowed(self.manage_FTPget,
  286.                               self.manage_FTPget.__roles__):
  287.                 mode=mode | 0004
  288.                 
  289.         # check write permissions
  290.         if hasattr(self.aq_base,'PUT') and hasattr(self.PUT, '__roles__'):
  291.             try:
  292.                 if getSecurityManager().validateValue(self.PUT):
  293.                     mode=mode | 0220
  294.             except: pass
  295.             
  296.             if nobody.allowed(self.PUT, self.PUT.__roles__):
  297.                 mode=mode | 0002
  298.                 
  299.         # get size
  300.         if hasattr(self, 'get_size'):
  301.             size=self.get_size()
  302.         elif hasattr(self,'manage_FTPget'):
  303.             size=len(self.manage_FTPget())
  304.         else:
  305.             size=0
  306.         # get modification time
  307.         mtime=self.bobobase_modification_time().timeTime()
  308.         # get owner and group
  309.         owner=group='Zope'
  310.         for user, roles in self.get_local_roles():
  311.             if 'Owner' in roles:
  312.                 owner=user
  313.                 break
  314.         return marshal.dumps((mode,0,0,1,owner,group,size,mtime,mtime,mtime))
  315.  
  316.     def manage_FTPlist(self,REQUEST):
  317.         """Directory listing for FTP. In the case of non-Foldoid objects,
  318.         the listing should contain one object, the object itself."""
  319.         # check to see if we are being acquiring or not
  320.         ob=self
  321.         while 1:
  322.             if App.Common.is_acquired(ob):
  323.                 raise ValueError('FTP List not supported on acquired objects')
  324.             if not hasattr(ob,'aq_parent'):
  325.                 break
  326.             ob=ob.aq_parent
  327.             
  328.         stat=marshal.loads(self.manage_FTPstat(REQUEST))
  329.         if callable(self.id): id=self.id()
  330.         else: id=self.id
  331.         return marshal.dumps((id,stat))
  332.  
  333.     def __len__(self):
  334.         return 1
  335.  
  336.  
  337. Globals.default__class_init__(Item)
  338.  
  339. class Item_w__name__(Item):
  340.     """Mixin class to support common name/id functions"""
  341.  
  342.     def title_or_id(self):
  343.         """Utility that returns the title if it is not blank and the id
  344.         otherwise."""
  345.         return self.title or self.__name__
  346.  
  347.     def title_and_id(self):
  348.         """Utility that returns the title if it is not blank and the id
  349.         otherwise.  If the title is not blank, then the id is included
  350.         in parens."""
  351.         t=self.title
  352.         return t and ("%s (%s)" % (t,self.__name__)) or self.__name__
  353.  
  354.     def _setId(self, id):
  355.         self.__name__=id
  356.  
  357.     def getPhysicalPath(self):
  358.         '''Returns a path (an immutable sequence of strings)
  359.         that can be used to access this object again
  360.         later, for example in a copy/paste operation.  getPhysicalRoot()
  361.         and getPhysicalPath() are designed to operate together.
  362.         '''
  363.         path = (self.__name__,)
  364.         
  365.         p = getattr(self,'aq_inner', None)
  366.         if p is not None: 
  367.             path = p.aq_parent.getPhysicalPath() + path
  368.             
  369.         return path
  370.  
  371.  
  372. def format_exception(etype,value,tb,limit=None):
  373.     import traceback
  374.     result=['Traceback (innermost last):']
  375.     if limit is None:
  376.         if hasattr(sys, 'tracebacklimit'):
  377.             limit = sys.tracebacklimit
  378.     n = 0
  379.     while tb is not None and (limit is None or n < limit):
  380.         f = tb.tb_frame
  381.         lineno = tb.tb_lineno
  382.         co = f.f_code
  383.         filename = co.co_filename
  384.         name = co.co_name
  385.         locals=f.f_locals
  386.         result.append('  File %s, line %d, in %s'
  387.                       % (filename,lineno,name))
  388.         try: result.append('    (Object: %s)' %
  389.                            locals[co.co_varnames[0]].__name__)
  390.         except: pass
  391.         try: result.append('    (Info: %s)' %
  392.                            str(locals['__traceback_info__']))
  393.         except: pass
  394.         tb = tb.tb_next
  395.         n = n+1
  396.     result.append(join(traceback.format_exception_only(etype, value),' '))
  397.     return result
  398.  
  399. def pretty_tb(t,v,tb):
  400.     tb=format_exception(t,v,tb,200)
  401.     tb=join(tb,'\n')
  402.     return tb
  403.  
  404. class SimpleItem(Item, Globals.Persistent,
  405.                  Acquisition.Implicit,
  406.                  AccessControl.Role.RoleManager,
  407.                  ):
  408.     # Blue-plate special, Zope Masala
  409.     """Mix-in class combining the most common set of basic mix-ins
  410.     """
  411.  
  412.     manage_options=Item.manage_options+(
  413.         {'label':'Security',   'action':'manage_access'},
  414.         )
  415.  
  416.     __ac_permissions__=(('View', ()),)
  417.